home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / XmeNamedSink.z / XmeNamedSink
Text File  |  1998-10-30  |  11KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmeeeeNNNNaaaammmmeeeeddddSSSSiiiinnnnkkkk((((ooootttthhhheeeerrrr))))       UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV       XXXXmmmmeeeeNNNNaaaammmmeeeeddddSSSSiiiinnnnkkkk((((ooootttthhhheeeerrrr))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmeeeeNNNNaaaammmmeeeeddddSSSSiiiinnnnkkkk - A toolkit function that transfers data from
  10.           the named selection to a widget
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/TransferP.h>
  14.           BBBBoooooooolllleeeeaaaannnn XXXXmmmmeeeeNNNNaaaammmmeeeeddddSSSSiiiinnnnkkkk(
  15.           WWWWiiiiddddggggeeeetttt wwwwiiiiddddggggeeeetttt,
  16.           AAAAttttoooommmm nnnnaaaammmmeeeedddd____sssseeeelllleeeeccccttttiiiioooonnnn,
  17.           XXXXttttEEEEnnnnuuuummmm oooopppp,
  18.           XXXXttttPPPPooooiiiinnnntttteeeerrrr llllooooccccaaaattttiiiioooonnnn____ddddaaaattttaaaa,
  19.           TTTTiiiimmmmeeee ttttiiiimmmmeeee);
  20.  
  21.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  22.           This page documents Motif 2.1.
  23.  
  24.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  25.           XXXXmmmmeeeeNNNNaaaammmmeeeeddddSSSSiiiinnnnkkkk transfers data from the specified selection to
  26.           a widget.
  27.  
  28.           This routine initializes an XXXXmmmmDDDDeeeessssttttiiiinnnnaaaattttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt with
  29.           the _s_e_l_e_c_t_i_o_n member set to _n_a_m_e_d__s_e_l_e_c_t_i_o_n, the _o_p_e_r_a_t_i_o_n
  30.           member set to the value of the _o_p argument, the
  31.           _l_o_c_a_t_i_o_n__d_a_t_amember set to the value of the _l_o_c_a_t_i_o_n__d_a_t_a
  32.           argument, and the _t_i_m_e member set to the value of the _t_i_m_e
  33.           argument.  The _l_o_c_a_t_i_o_n__d_a_t_a value contains information
  34.           about the location where data is to be transferred.  If the
  35.           value is _N_U_L_L, the data is to be inserted at the widget's
  36.           cursor position.  Otherwise, the type and interpretation of
  37.           the value are specific to the widget class.
  38.  
  39.           This routine calls the widget's
  40.           ddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnPPPPrrrreeeeHHHHooooooookkkkPPPPrrrroooocccc_X_m_Q_T_t_r_a_n_s_f_e_r trait method with this
  41.           XXXXmmmmDDDDeeeessssttttiiiinnnnaaaattttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt.  It then calls the widget's
  42.           XXXXmmmmNNNNddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkk procedures, if any.  Unless an
  43.           XXXXmmmmNNNNddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkk procedure has called _X_m_T_r_a_n_s_f_e_r_D_o_n_e
  44.           with a status other than XXXXmmmmTTTTRRRRAAAANNNNSSSSFFFFEEEERRRR____DDDDOOOONNNNEEEE____DDDDEEEEFFFFAAAAUUUULLLLTTTT, this
  45.           routine calls the widget's ddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnPPPPrrrroooocccc _X_m_Q_T_t_r_a_n_s_f_e_r
  46.           trait method after all transfers initiated by callback
  47.           procedures have finished.  It is the responsibility of the
  48.           XXXXmmmmNNNNddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkk procedures and the ddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnPPPPrrrroooocccc
  49.           method to transfer any data to the widget.
  50.  
  51.           If _o_p is XXXXmmmmMMMMOOOOVVVVEEEE and the data is successfully transferred,
  52.           XXXXmmmmeeeeNNNNaaaammmmeeeeddddSSSSiiiinnnnkkkk asks the owner of the selection named by
  53.           _n_a_m_e_d__s_e_l_e_c_t_i_o_n to convert that selection to the _D_E_L_E_T_E
  54.           target.  If the selection owner has called XXXXmmmmeeeeNNNNaaaammmmeeeeddddSSSSoooouuuurrrrcccceeee to
  55.           take ownership of the selection, this conversion request
  56.           first calls the owner's XXXXmmmmNNNNccccoooonnnnvvvveeeerrrrttttCCCCaaaallllllllbbbbaaaacccckkkk procedures, if
  57.           any.  If no XXXXmmmmNNNNccccoooonnnnvvvveeeerrrrttttCCCCaaaallllllllbbbbaaaacccckkkk procedures exist or if these
  58.           procedures return a status of XXXXmmmmCCCCOOOONNNNVVVVEEEERRRRTTTT____DDDDEEEEFFFFAAAAUUUULLLLTTTT or
  59.           XXXXmmmmCCCCOOOONNNNVVVVEEEERRRRTTTT____MMMMEEEERRRRGGGGEEEE, this request then calls the owner's
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmeeeeNNNNaaaammmmeeeeddddSSSSiiiinnnnkkkk((((ooootttthhhheeeerrrr))))       UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV       XXXXmmmmeeeeNNNNaaaammmmeeeeddddSSSSiiiinnnnkkkk((((ooootttthhhheeeerrrr))))
  71.  
  72.  
  73.  
  74.           ccccoooonnnnvvvveeeerrrrttttPPPPrrrroooocccc _X_m_Q_T_t_r_a_n_s_f_e_rtrait method.
  75.  
  76.           _w_i_d_g_e_t    Specifies the widget that is the destination for
  77.                     the data.
  78.  
  79.           _n_a_m_e_d__s_e_l_e_c_t_i_o_n
  80.                     Specifies the desired selection from which to
  81.                     obtain the data.
  82.  
  83.           _o_p        Specifies the transfer operation.  Possible values
  84.                     are XXXXmmmmCCCCOOOOPPPPYYYY, XXXXmmmmMMMMOOOOVVVVEEEE, and XXXXmmmmLLLLIIIINNNNKKKK.
  85.  
  86.           _l_o_c_a_t_i_o_n__d_a_t_a
  87.                     Specifies information about the location where
  88.                     data is to be transferred.  If the value is _N_U_L_L,
  89.                     the data is to be inserted at the widget's cursor
  90.                     position.  Otherwise, the type and interpretation
  91.                     of the value are specific to the widget class. If
  92.                     _l_o_c_a_t_i_o_n__d_a_t_a cannot fit inside an _X_t_P_o_i_n_t_e_r,
  93.                     _l_o_c_a_t_i_o_n__d_a_t_a must either be a static variable or
  94.                     be allocated. If _l_o_c_a_t_i_o_n__d_a_t_a is allocated, a
  95.                     call must be made to XXXXmmmmeeeeTTTTrrrraaaannnnssssffffeeeerrrrAAAAddddddddDDDDoooonnnneeeePPPPrrrroooocccc to
  96.                     establish a procedure to free the allocated
  97.                     memory. The value of _l_o_c_a_t_i_o_n__d_a_t_a is only valid
  98.                     for the duration of a transfer.  Once transfer
  99.                     done procedures start to be called, _l_o_c_a_t_i_o_n__d_a_t_a
  100.                     will no longer be stable.
  101.  
  102.           _t_i_m_e      Specifies the time of the transfer.  This is
  103.                     usually the timestamp from the event passed to an
  104.                     action routine.  You should call
  105.                     _X_t_L_a_s_t_T_i_m_e_S_t_a_m_p_P_r_o_c_e_s_s_e_d to generate the
  106.                     _t_i_m_evalue.  If you set _t_i_m_e to CCCCuuuurrrrrrrreeeennnnttttTTTTiiiimmmmeeee or 0,
  107.                     UTM will automatically change the call to
  108.                     _X_t_L_a_s_t_T_i_m_e_S_t_a_m_p_P_r_o_c_e_s_s_e_d.
  109.  
  110.      RRRREEEETTTTUUUURRRRNNNN
  111.           This function returns False if no transfers take place.
  112.           Otherwise, it returns True.
  113.  
  114.      RRRREEEELLLLAAAATTTTEEEEDDDD
  115.           XXXXmmmmQQQQTTTTttttrrrraaaannnnssssffffeeeerrrr(3), XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrDDDDoooonnnneeee(3), XXXXmmmmTTTTrrrraaaannnnssssffffeeeerrrrVVVVaaaalllluuuueeee(3),
  116.           XXXXmmmmeeeeCCCClllliiiippppbbbbooooaaaarrrrddddSSSSiiiinnnnkkkk(3), XXXXmmmmeeeeCCCClllliiiippppbbbbooooaaaarrrrddddSSSSoooouuuurrrrcccceeee(3),
  117.           XXXXmmmmeeeeCCCCoooonnnnvvvveeeerrrrttttMMMMeeeerrrrggggeeee(3), XXXXmmmmeeeeDDDDrrrraaaaggggSSSSoooouuuurrrrcccceeee(3), XXXXmmmmeeeeDDDDrrrrooooppppSSSSiiiinnnnkkkk(3),
  118.           XXXXmmmmeeeeGGGGeeeettttEEEEnnnnccccooooddddiiiinnnnggggAAAAttttoooommmm(3), XXXXmmmmeeeePPPPrrrriiiimmmmaaaarrrryyyySSSSoooouuuurrrrcccceeee(3),
  119.           XXXXmmmmeeeeNNNNaaaammmmeeeeddddSSSSoooouuuurrrrcccceeee(3), XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyySSSSiiiinnnnkkkk(3),
  120.           XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyySSSSoooouuuurrrrcccceeee(3), XXXXmmmmeeeeSSSSeeeeccccoooonnnnddddaaaarrrryyyyTTTTrrrraaaannnnssssffffeeeerrrr(3),
  121.           XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddCCCCoooonnnnvvvveeeerrrrtttt(3), XXXXmmmmeeeeSSSSttttaaaannnnddddaaaarrrrddddTTTTaaaarrrrggggeeeettttssss(3), and
  122.           XXXXmmmmeeeeTTTTrrrraaaannnnssssffffeeeerrrrAAAAddddddddDDDDoooonnnneeeePPPPrrrroooocccc(3).
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.